Skip to main content

​
Endpoint

GET /api/v1/boards
List boards visible to the current organization member. Results can be filtered by gateway or board group and are paginated using limit/offset parameters.

​
Query Parameters

​
gateway_id
string (UUID)
Filter boards by gateway ID. Only returns boards associated with the specified gateway.
​
board_group_id
string (UUID)
Filter boards by board group ID. Only returns boards that belong to the specified group.
​
limit
integer
default:"50"
Maximum number of boards to return per page.
​
offset
integer
default:"0"
Number of boards to skip before starting to return results.

​
Response

Returns a paginated list of boards sorted alphabetically by name (case-insensitive), then by creation date (descending).
​
items
array
Array of board objects
​
id
string (UUID)
Unique identifier for the board
​
organization_id
string (UUID)
Organization that owns this board
​
name
string
Display name of the board
​
slug
string
URL-friendly identifier
​
description
string
Detailed description of the board’s purpose
​
gateway_id
string (UUID)
Gateway associated with this board
​
board_group_id
string (UUID)
Board group this board belongs to, if any
​
board_type
string
default:"goal"
Type of board (e.g., “goal”)
​
objective
string
Primary objective for goal boards
​
success_metrics
object
Key-value pairs defining success criteria
​
target_date
string (datetime)
Target completion date in ISO 8601 format
​
goal_confirmed
boolean
default:"false"
Whether the goal has been confirmed
​
goal_source
string
Source or origin of the goal
​
require_approval_for_done
boolean
default:"true"
Whether tasks require approval before marking as done
​
require_review_before_done
boolean
default:"false"
Whether tasks require review before completion
​
block_status_changes_with_pending_approval
boolean
default:"false"
Whether status changes are blocked when approval is pending
​
only_lead_can_change_status
boolean
default:"false"
Whether only the board lead can change task status
​
max_agents
integer
default:"1"
Maximum number of agents allowed on this board
​
created_at
string (datetime)
When the board was created (ISO 8601 format)
​
updated_at
string (datetime)
When the board was last updated (ISO 8601 format)
​
total
integer
Total number of boards matching the filter criteria
​
limit
integer
Maximum number of items per page
​
offset
integer
Number of items skipped

​
Example Request

curl -X GET "https://api.example.com/api/v1/boards?gateway_id=550e8400-e29b-41d4-a716-446655440000&limit=20" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

​
Example Response

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "organization_id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Q1 Product Launch",
      "slug": "q1-product-launch",
      "description": "Launch new product features for Q1 2026",
      "gateway_id": "550e8400-e29b-41d4-a716-446655440000",
      "board_group_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "board_type": "goal",
      "objective": "Successfully launch product with 95% uptime",
      "success_metrics": {
        "uptime": "95%",
        "user_satisfaction": "4.5/5"
      },
      "target_date": "2026-03-31T23:59:59Z",
      "goal_confirmed": true,
      "goal_source": "Product roadmap Q1 2026",
      "require_approval_for_done": true,
      "require_review_before_done": false,
      "block_status_changes_with_pending_approval": false,
      "only_lead_can_change_status": false,
      "max_agents": 3,
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-02-20T14:45:00Z"
    }
  ],
  "total": 1,
  "limit": 20,
  "offset": 0
}

​
Authorization

Requires organization member authentication. Users can only see boards they have read access to based on their organization membership.